diff --git a/README.md b/README.md index f7a8053..4ac88e3 100644 --- a/README.md +++ b/README.md @@ -1,101 +1,101 @@ # ClusterLabs.org website ## Installing Jekyll ClusterLabs,org is partially generated by jekyll. Installing jekyll requires the following dependencies: * nodejs * npm * ruby * ruby-devel * rubygems * rubygem-bundler * rubygem-rdiscount Once you have those, change to the `src` directory and run `bundle install`. ## Using Jekyll ClusterLabs.org's jekyll source is under the `src` directory. Jekyll will generate static content to the html directory. To generate content in a checkout for development and testing, change to the `src` directory and run `bundle exec jekyll build` (to merely generate content) or `bundle exec jekyll serve` (to generate and test via a local server). To generate content on the production site, run -`JEKYLL_ENV=production jekyll build` (which will enable such things as site -analytics and asset digests). +`JEKYLL_ENV=production jekyll build` (which will enable such things as asset +digests). If `src/Gemfile` changes, re-run `bundle install` afterward. ## Images, stylesheets and JavaScripts We use the jekyll-assets plugin to manage "assets" such as images, stylesheets, and JavaScript. One advantage is that digest hashes are automatically added to the generated filenames when in production mode. This allows "cache busting" when an asset changes, so we can use long cache times on the server end. Another advantage is that sources are minified when in production mode. How CSS is managed: * CSS is generated from SASS sources * `src/_assets/stylesheets/main.scss` is just a list of imports * all other *.scss files beneath `src/_assets/stylesheets` contain the SASS to be imported by `main.scss` * jekyll will generate `html/assets/main.css` (or `main-_HASH_.css`) as the combination of all imports * web pages can reference the stylesheet via `{% stylesheet main %}` JavaScript is managed similarly: * `src/_assets/javascripts/main.js` is just a list of requires * `src/_assets/javascripts/*.js` contain the JavaScript to be required by `main.js` * jekyll will copy these to `html/assets` * jekyll will generate `html/assets/main.js` (or `main-_HASH_.js`) as the combination of all JavaScript * web pages can reference the script via `{% javascript main %}` How images are managed: * `src/_assets/images/*` are our images * web pages can add an img tag using `{% image _NAME_._EXT_ %}` * web pages can reference a path to an image (e.g. in a link's href) using `{% asset_path _NAME_._EXT_ %}` * CSS can reference a path to an image using `url(asset_path("_NAME_._EXT_"))` * only images that are referenced in one of these ways will be deployed to the website, so `_assets` may contain image sources such as SVGs that do not need to be deployed * Tip: http://compresspng.com/ can often compress PNGs extremely well ## Site icons Site icons used to be easy, right? `favicon.ico` seems downright traditional. Unfortunately, site icons have become an ugly mess of incompatible proprietary extensions. Even `favicon.ico` is just a proprietary extension (and obsolete, as well). Now, there are also `apple-touch-icon[-NxN][-precomposed].png` (with at least _12_ different sizes!), `browserconfig.xml`, `manifest.json`, link tags with `rel=(icon|shortcut icon|apple-touch-icon-*)`, and Windows Phone tile overlay divs. If you want to be discouraged and confused, see: * http://stackoverflow.com/questions/23849377/html-5-favicon-support * https://mathiasbynens.be/notes/touch-icons * https://css-tricks.com/favicon-quiz/ There is no way to handle the mess universally. In particular, some devices do much better when different icon sizes are provided and listed in the HTML as link tags, and will pick the size needed, whereas other devices will download every single icon listed in those link tags, crippling page performance -- not to mention the overhead that listing two dozen icon sizes adds to the HTML. We've chosen a simple approach: provide two site icons, a 16x16 `favicon.ico`, and a 180x180 `apple-touch-icon.png`, both listed in link tags in the HTML. Most browsers/devices will choose one of these and scale it as needed. ## Web server configuration The clusterlabs.org web server is configured to redirect certain old URLs to their new locations, so be careful about renaming files. diff --git a/src/_config.yml b/src/_config.yml index dee311a..af1f17c 100644 --- a/src/_config.yml +++ b/src/_config.yml @@ -1,53 +1,52 @@ # Welcome to Jekyll! # # This config file is meant for settings that affect your whole blog, values # which you are expected to set up once and rarely edit after that. If you find # yourself editing these this file very often, consider using Jekyll's data files # feature for the data you need to update frequently. # # For technical reasons, this file is *NOT* reloaded automatically when you use # 'bundle exec jekyll serve'. If you change this file, please restart the server process. # Site settings # These are used to personalize your new site. If you look in the HTML files, # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. # You can create any custom variable you would like, and they will be accessible # in the templates via {{ site.myvariable }}. title: ClusterLabs email: users@clusterlabs.org description: Community hub for open-source high-availability software url: https://www.clusterlabs.org/ -google_analytics: UA-8156370-1 # Build settings theme: minima destination: ../html gems: - jekyll-assets - font-awesome-sass include: - doc - pacemaker - polls exclude: - Gemfile - Gemfile.lock - LICENSE.theme # All content generated outside of jekyll, or not yet converted to jekyll, # must be listed here, or jekyll will erase it when building the site. # Though not documented as such, the values here function as prefix matches. keep_files: - images - doc/Two-Stacks.pdf - pacemaker/abi - pacemaker/doc - pacemaker/doxygen - pacemaker/global - pacemaker/man - Pictures - rpm-test - rpm-test-next - rpm-test-rhel diff --git a/src/_includes/google-analytics.html b/src/_includes/google-analytics.html deleted file mode 100644 index 19bd70a..0000000 --- a/src/_includes/google-analytics.html +++ /dev/null @@ -1,6 +0,0 @@ - diff --git a/src/_includes/head.html b/src/_includes/head.html index 6612f63..366368b 100644 --- a/src/_includes/head.html +++ b/src/_includes/head.html @@ -1,18 +1,14 @@ {{ site.title | escape }}{% if page.title %} > {{ page.title | escape }}{% endif %} {% stylesheet main %} - - {% if jekyll.environment == "production" and site.google_analytics %} - {% include google-analytics.html %} - {% endif %}